Feature: Xcode 16.0 support #942

Brett-Best · 2024-06-10T23:42:06Z

Initial support for Xcode 16 which changed object versions and introduced a new attribute.

Brett-Best · 2024-06-10T23:43:00Z

spec/project/object/root_object_spec.rb

@@ -43,6 +43,10 @@ module ProjectSpecs
      @root_object.minimized_project_reference_proxies.should == '0'
    end

+    it 'returns the preferred project object version' do
+      @root_object.preferred_project_object_version.should == '73'


I suspect we will want to check that this is in a set like the LAST_KNOWN_OBJECT_VERSION, my knowledge of the code doesn't extend that far unfortunately

Brett-Best · 2024-06-10T23:44:17Z

Some of the other variable such as LAST_KNOWN_SWIFT_VERSION could do with updating as well

igor-makarov · 2024-09-02T13:17:38Z

lib/xcodeproj/project/object/file_system_synchronized_root_group.rb

+  class Project
+    module Object
+      # This class represents a file system synchronized root group.
+      class PBXFileSystemSynchronizedRootGroup < AbstractObject


@Brett-Best thank you for working on this!

Unfortunately, from what I was able to gather, the implementation is a tiny bit incomplete.

There are a few attributes that PBXFileSystemSynchronizedRootGroup has in common with PBXGroup, such as tabs/indent properties.

There are also some properties unique to PBXFileSystemSynchronizedRootGroup that need to be added, such as explicitFileTypes, explicitFolders and exceptions (which require a further PBXFileSystemSynchronizedBuildFileExceptionSet object to represent).

Without this, I believe the representation will be incomplete and cause crashes.

I can recommend this article on synchronized groups by @pepicrft or this Tuist PR by the same for further info.

Thanks for the reply, yeah, it would be nice if the project file specification was published somewhere 🙃.
Yep, I expect if the project file uses these additional attributes that warnings/errors/crashes should be emitted.

I basically just added support to unblock the current utilization of the PBXFileSystemSynchronizedRootGroup in a project I was working on.

I may or may not end up updating this PR with the additional types, given CocoaPods is now in maintenance mode 😄.

Unfortunately, can't migrate off of CocoaPods to SPM yet because React Native 😢

You know, I don't think you're that far away! There are only a few things missing:

Copy attributes from PBXGroup to PBXFileSystemSynchronizedRootGroup: name, uses_tabs, indent_width, tab_width, wraps_lines

Add new attributes to PBXFileSystemSynchronizedRootGroup:

explicit_file_types (type Hash)

explicit_folders (type Array)

exceptions (relation, has_many of type PBXFileSystemSynchronizedBuildFileExceptionSet)

Add new type PBXFileSystemSynchronizedBuildFileExceptionSet with attributes:

target (relation, has_one AbstractTarget)

membership_exceptions (type Array)

public_headers (type Array)

private_headers (type Array)

additional_compiler_flags_by_relative_path (type Hash)

attributes_by_relative_path (type Hash)

Thanks for the reply, I've run into a new issue:

When a build configuration uses an xcconfig in the new folders the baseConfigurationReference is removed and replaced with baseConfigurationReferenceAnchor (PBXFileSystemSynchronizedRootGroup) and baseConfigurationReferenceRelativePath.

I managed to add that to the xcodeproj mostly fine but on the cocoapods side it needs some love at least in this section:
https://github.com/CocoaPods/CocoaPods/blob/85e6d43ca63f8acf0bb3f3d910e8ff1f6558a4e8/lib/cocoapods/installer/user_project_integrator/target_integrator/xcconfig_integrator.rb#L44-L66

Another issue is that my change adds file_system_synchronized_groups to all entries which is fine but when you edit the project file in Xcode, it removes the entries that are empty arrays.

Would you have any idea how I can stop Xcodeproj from adding empty array entries?

Same issue above with the exceptions key of a PBXFileSystemSynchronizedRootGroup.

@Brett-Best I've looked at the rest of the uses of has_many - I think it's not possible to avoid initializing the empty ObjectList. Is this causing any issues? From what I know, many other things generated by Xcodeproj get modified by Xcode, and this has never been a concern.

In any case, great work! There are just a few more attributes to add, I think all of those are simple value types:

Copy attributes from PBXGroup to PBXFileSystemSynchronizedRootGroup: name, uses_tabs, indent_width, tab_width, wraps_lines

Add new attributes to PBXFileSystemSynchronizedRootGroup:

explicit_file_types (type Hash)

explicit_folders (type Array)

Add new attributes to PBXFileSystemSynchronizedBuildFileExceptionSet:

public_headers (type Array)

private_headers (type Array)

additional_compiler_flags_by_relative_path (type Hash)

attributes_by_relative_path (type Hash)

@igor-makarov along with the additional attributes listed, hopefully they don't also add empty groups.
Yes it is an issue, other things in the Pod project can sometimes change if you open it in Xcode to inspect the settings etc but this far less likely to be done on a day to day basis.
Whereas changing the settings of your own project is much more common.
Where I work atm we have churn of this getting added in / removed.
As a workaround I did come up with some regex but I couldn't get it to work on shell cause multiline hah...

marcpalmer · 2024-09-08T20:31:00Z

FYI fastlane's dependency on xcodeproj means that you can't build Xcode 16 projects that have the new PBXFileSystemSynchronizedRootGroup node type added e.g. if you add a widgets extension in Xcode 16 beta, it uses this node type and then you can no longer build with fastlane.

The workaround in this case is to remove that node from your project in Xcode 16, removing the references only, then open the project in Xcode 15, add the container node again/add the files back again, which creates the node as a PBXGroup, and then you can open the project in both 15 and 16 fine and xcodeproj can parse it fine and fastlane will build even with the Xcode 16 buildchain.

drewolbrich · 2024-09-08T20:58:06Z

FYI fastlane's dependency on xcodeproj means that you can't build Xcode 16 projects that have the new PBXFileSystemSynchronizedRootGroup node type added e.g. if you add a widgets extension in Xcode 16 beta, it uses this node type and then you can no longer build with fastlane.

I believe that more broadly, without similar workarounds, fastlane can't be used with any new project created with Xcode 16.

If you create a new iOS project with Xcode 16, its xcodeproj/project.pbxproj file will contain the string PBXFileSystemSynchronizedRootGroup.

Brett-Best · 2024-09-08T21:01:14Z

I wonder if it would be possible to have Fastlane use https://github.com/tuist/XcodeProj 🤔

pepicrft · 2024-09-10T11:23:00Z

I wonder if it would be possible to have Fastlane use https://github.com/tuist/XcodeProj 🤔

That'll be tricky. Through the Ruby version of XcodeProj, tools like Fastlane can manipulate the object directly in memory through the various getters and setters available in Ruby objects defined by this library. If we adopt something like Tuist's XcodeProj, we'd have to use something like Ruby FFI, so the interaction between Fastlane (Ruby) and XcodeProj (Swift) would have to be through a set of functions that capture the various operations that the Ruby side of things has interest in doing.

Westacular · 2024-09-18T19:02:13Z

FYI fastlane's dependency on xcodeproj means that you can't build Xcode 16 projects that have the new PBXFileSystemSynchronizedRootGroup node type added e.g. if you add a widgets extension in Xcode 16 beta, it uses this node type and then you can no longer build with fastlane.

The workaround in this case is to remove that node from your project in Xcode 16, removing the references only, then open the project in Xcode 15, add the container node again/add the files back again, which creates the node as a PBXGroup, and then you can open the project in both 15 and 16 fine and xcodeproj can parse it fine and fastlane will build even with the Xcode 16 buildchain.

I haven't tested this, but I think there's a more simple fix: in Xcode 16, select the folder in the Project navigator, and go to Edit > Convert > To Group.

That should convert the PBXFileSystemSynchronizedRootGroup to a PBXGroup that Xcodeproj and Fastlane can handle.

Levy4u · 2024-09-19T22:39:22Z

FYI fastlane's dependency on xcodeproj means that you can't build Xcode 16 projects that have the new PBXFileSystemSynchronizedRootGroup node type added e.g. if you add a widgets extension in Xcode 16 beta, it uses this node type and then you can no longer build with fastlane.
The workaround in this case is to remove that node from your project in Xcode 16, removing the references only, then open the project in Xcode 15, add the container node again/add the files back again, which creates the node as a PBXGroup, and then you can open the project in both 15 and 16 fine and xcodeproj can parse it fine and fastlane will build even with the Xcode 16 buildchain.

I haven't tested this, but I think there's a more simple fix: in Xcode 16, select the folder in the Project navigator, and go to Edit > Convert > To Group.

That should convert the PBXFileSystemSynchronizedRootGroup to a PBXGroup that Xcodeproj and Fastlane can handle.

"To Group" worked for me but I lost my app scheme. So I had to go to Product > Schemes > Autocreate Schemes Now, and it came back.

mlight3 · 2024-10-09T15:29:23Z

Any update or progress?

Brett-Best · 2024-10-09T15:35:27Z

@mlight3 I haven't made any further improvements as this currently is sufficient for my needs.

patrickhartling · 2024-10-09T15:48:29Z

What is the likelihood of this PR being approved? I work on a large team with a large code base, and being able to use folders instead of groups could save us a lot of hassle. For example, our project file size could be reduced by more than 26,000 lines through the use of folders. However, we cannot make that move because Fastlane cannot build our code without this gem supporting folders.

Brett-Best · 2024-10-09T16:02:32Z

@patrickhartling you can point to this using your Gemfile and it'll work in the meantime.
My feeling is a low chance of approval on this tbh, especially since it's not complete support.

orta · 2024-10-11T12:21:53Z

Anyone in the community can take over this PR if you want it merged, start a fork from the head commit on this branch and go through the feedback in the chat and then send a separate PR - Brett got a lot of the way there, and that's a good job but it doesn't have to be on them to wrap it up

igor-makarov · 2024-10-11T16:26:26Z

I agree - @Brett-Best did a great job putting together this PR and there's not much left!

There are just a few more attributes to add, I think all of those are simple value types:

Copy attributes from PBXGroup to PBXFileSystemSynchronizedRootGroup: name, uses_tabs, indent_width, tab_width, wraps_lines
Add new attributes to PBXFileSystemSynchronizedRootGroup:
- explicit_file_types (type Hash)
- explicit_folders (type Array)
Add new attributes to PBXFileSystemSynchronizedBuildFileExceptionSet:
- public_headers (type Array)
- private_headers (type Array)
- additional_compiler_flags_by_relative_path (type Hash)
- attributes_by_relative_path (type Hash)

Brett-Best · 2024-10-11T17:02:50Z

Replied to thread above, but one of the things that also needs done, which seems much more complicated is tuist/XcodeProj#852.

I also checked the box to allow: users with write access to CocoaPods/Xcodeproj can add new commits to your feature/Xcode-16.0-Support branch.

Harry-KNIGHT · 2024-10-25T13:41:19Z

Hi, any news on this PR ?

gui17aume · 2024-10-25T22:38:05Z

I made a new PR based on this one to add some missing attributes: #985

Hoping it will help!

Brett-Best commented Jun 10, 2024

View reviewed changes

Brett-Best added 3 commits August 21, 2024 20:31

Updated constants.rb to include Xcode 16.0 object version

f29aa8a

Added root object attribute for preferredProjectObjectVersion

4151dda

Updated object versions for Xcode 16.0b6

013bba2

Brett-Best force-pushed the feature/Xcode-16.0-Support branch from 4c9b2a0 to 013bba2 Compare August 21, 2024 10:34

Added support for PBXFileSystemSynchronizedRootGroups

a437b26

igor-makarov reviewed Sep 2, 2024

View reviewed changes

Added support for PBXFileSystemSynchronizedBuildFileExceptionSets

2b87c2c

defagos mentioned this pull request Sep 16, 2024

Update Xcode version to 16 SRGSSR/pillarbox-apple#988

Merged

4 tasks

CrazyFanFan mentioned this pull request Sep 20, 2024

PBXGroup attempted to initialize an object with unknown ISA PBXFileSystemSynchronizedRootGroup CocoaPods/CocoaPods#12456

Open

fthdgn mentioned this pull request Oct 8, 2024

Doesn't support the new Xcode 16 folder format (unknown ISA PBXFileSystemSynchronizedRootGroup) fastlane/fastlane#22265

Open

4 tasks

Brett-Best mentioned this pull request Oct 9, 2024

Fix for builds broken by Xcode 16 #975

Closed

authiatr mentioned this pull request Oct 24, 2024

Xcodeproj doesn't know about XCBuildConfiguration / baseConfigurationReferenceAnchor #981

Closed

gui17aume mentioned this pull request Oct 25, 2024

Add support for Xcode 16 and synchronized groups #985

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Xcode 16.0 support #942

Feature: Xcode 16.0 support #942

Brett-Best commented Jun 10, 2024 •

edited

Loading

Brett-Best Jun 10, 2024 •

edited

Loading

Brett-Best commented Jun 10, 2024

igor-makarov Sep 2, 2024

Brett-Best Sep 2, 2024

igor-makarov Sep 3, 2024

Brett-Best Sep 9, 2024

Brett-Best Sep 9, 2024

Brett-Best Sep 11, 2024

igor-makarov Sep 12, 2024

Brett-Best Oct 11, 2024

marcpalmer commented Sep 8, 2024 •

edited

Loading

drewolbrich commented Sep 8, 2024

Brett-Best commented Sep 8, 2024

pepicrft commented Sep 10, 2024

Westacular commented Sep 18, 2024

Levy4u commented Sep 19, 2024 •

edited

Loading

mlight3 commented Oct 9, 2024

Brett-Best commented Oct 9, 2024 •

edited

Loading

patrickhartling commented Oct 9, 2024

Brett-Best commented Oct 9, 2024 •

edited

Loading

orta commented Oct 11, 2024

igor-makarov commented Oct 11, 2024

Brett-Best commented Oct 11, 2024

Harry-KNIGHT commented Oct 25, 2024

gui17aume commented Oct 25, 2024

Feature: Xcode 16.0 support #942

Are you sure you want to change the base?

Feature: Xcode 16.0 support #942

Conversation

Brett-Best commented Jun 10, 2024 • edited Loading

Brett-Best Jun 10, 2024 • edited Loading

Choose a reason for hiding this comment

Brett-Best commented Jun 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcpalmer commented Sep 8, 2024 • edited Loading

drewolbrich commented Sep 8, 2024

Brett-Best commented Sep 8, 2024

pepicrft commented Sep 10, 2024

Westacular commented Sep 18, 2024

Levy4u commented Sep 19, 2024 • edited Loading

mlight3 commented Oct 9, 2024

Brett-Best commented Oct 9, 2024 • edited Loading

patrickhartling commented Oct 9, 2024

Brett-Best commented Oct 9, 2024 • edited Loading

orta commented Oct 11, 2024

igor-makarov commented Oct 11, 2024

Brett-Best commented Oct 11, 2024

Harry-KNIGHT commented Oct 25, 2024

gui17aume commented Oct 25, 2024

Brett-Best commented Jun 10, 2024 •

edited

Loading

Brett-Best Jun 10, 2024 •

edited

Loading

marcpalmer commented Sep 8, 2024 •

edited

Loading

Levy4u commented Sep 19, 2024 •

edited

Loading

Brett-Best commented Oct 9, 2024 •

edited

Loading

Brett-Best commented Oct 9, 2024 •

edited

Loading